package cn.vehicle.config;

import jakarta.validation.Constraint;
import jakarta.validation.Payload;

import java.lang.annotation.*;

/**
 * 枚举值校验注解
 * <p>
 * 用于标注在字段上，校验该字段的值是否属于指定的枚举类型。
 * 结合 {@link EnumValueValidator} 使用，用于 Jakarta Validation 框架自动校验。
 * </p>
 *
 * <p>使用示例：</p>
 * <pre>
 *     exp
 *     EnumValue(enumClass = StatusEnum.class, message = "状态值不合法")
 *     private String status;
 * </pre>
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
@Constraint(
        validatedBy = {EnumValueValidator.class}
)
public @interface EnumValue {

    /**
     * 指定要校验的目标枚举类
     *
     * @return 枚举类对象
     */
    Class<? extends Enum<?>> enumClass();

    /**
     * 校验失败时返回的默认提示消息
     *
     * @return 默认提示文本
     */
    String message() default "传入参数不合法";

    /**
     * 分组校验功能（一般用于区分不同的校验场景）
     *
     * @return 分组类数组
     */
    Class<?>[] groups() default {};

    /**
     * 扩展属性，用于携带元信息（通常不使用）
     *
     * @return Payload 数组
     */
    Class<? extends Payload>[] payload() default {};
}
